/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.tracker.imports;

import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.hasSize;

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import java.io.File;
import org.hisp.dhis.helpers.file.FileReaderUtils;
import org.hisp.dhis.test.e2e.Constants;
import org.hisp.dhis.test.e2e.actions.LoginActions;
import org.hisp.dhis.test.e2e.actions.MessageConversationsActions;
import org.hisp.dhis.test.e2e.actions.RestApiActions;
import org.hisp.dhis.test.e2e.actions.metadata.ProgramStageActions;
import org.hisp.dhis.test.e2e.dto.ApiResponse;
import org.hisp.dhis.test.e2e.helpers.JsonObjectBuilder;
import org.hisp.dhis.test.e2e.helpers.QueryParamsBuilder;
import org.hisp.dhis.tracker.TrackerApiTest;
import org.hisp.dhis.tracker.imports.databuilder.TrackedEntityDataBuilder;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

/**
 * @author Gintare Vilkelyte <vilkelyte.gintare@gmail.com>
 */
public class SideEffectsTests extends TrackerApiTest {
  private String trackerProgramStageId = "PaOOjwLVW23";

  private String trackerProgramId = Constants.TRACKER_PROGRAM_ID;

  private MessageConversationsActions messageConversationsActions;

  @BeforeAll
  public void beforeAll() throws Exception {
    messageConversationsActions = new MessageConversationsActions();

    new LoginActions().loginAsSuperUser();

    setupData();
  }

  @ParameterizedTest
  @ValueSource(strings = {"true", "false"})
  @Disabled("todo: fix this test 12098")
  public void shouldSendNotificationIfNotSkipSideEffects(Boolean shouldSkipSideEffects) {
    JsonObject object =
        new TrackedEntityDataBuilder()
            .buildWithEnrollmentAndEvent(
                Constants.TRACKED_ENTITY_TYPE,
                Constants.ORG_UNIT_IDS[0],
                trackerProgramId,
                trackerProgramStageId,
                "COMPLETED");

    ApiResponse response =
        new RestApiActions("/messageConversations")
            .get("", new QueryParamsBuilder().add("fields=*"));

    int size = response.getBody().getAsJsonArray("messageConversations").size();

    trackerImportExportActions
        .postAndGetJobReport(
            object, new QueryParamsBuilder().add("skipSideEffects=" + shouldSkipSideEffects))
        .validateSuccessfulImport();

    int expectedCount = (shouldSkipSideEffects) ? size : size + 1;

    response = messageConversationsActions.waitForNotification(expectedCount);

    response.validate().statusCode(200).body("messageConversations", hasSize(expectedCount));

    if (shouldSkipSideEffects) {
      return;
    }

    response
        .validate()
        .body("messageConversations.subject", hasItem("TA program stage completion"));
  }

  private void setupData() throws Exception {
    ProgramStageActions programStageActions = new ProgramStageActions();

    JsonArray array =
        new FileReaderUtils()
            .read(new File("src/test/resources/tracker/notificationTemplates.json"))
            .get(JsonObject.class)
            .getAsJsonArray("programNotificationTemplates");

    array.forEach(
        nt -> {
          String programNotificationTemplate =
              new RestApiActions("/programNotificationTemplates")
                  .post(nt.getAsJsonObject())
                  .extractUid();

          JsonObject programStage =
              JsonObjectBuilder.jsonObject(programStageActions.get(trackerProgramStageId).getBody())
                  .addOrAppendToArray(
                      "notificationTemplates",
                      new JsonObjectBuilder()
                          .addProperty("id", programNotificationTemplate)
                          .build())
                  .build();

          programStageActions
              .update(trackerProgramStageId, programStage)
              .validate()
              .statusCode(200);

          programStageActions
              .get(trackerProgramStageId)
              .validate()
              .body("notificationTemplates.id", hasItem(programNotificationTemplate));
        });
  }
}
